docs: Modify installation instruction for dependencies#42
docs: Modify installation instruction for dependencies#42sbillinge merged 3 commits intoPDF-bl:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@sbillinge, it's ready for review. |
README.rst
Outdated
|
|
||
| But then you need to install its dependencies manually. Use the following commands :: | ||
|
|
||
| wget https://raw.githubusercontent.com/PDF-bl/pdfbl.sequential/main/requirements/conda.txt |
There was a problem hiding this comment.
This will only work on Linux and Mac. This may be ok, but let's make that decision explicitly. Do we ever envisage users installing this on their local computers?
There was a problem hiding this comment.
I did this because I think letting conda.txt be installed before feeding it to conda install --file gives the user the option to examine its contents before running the command.
But now you mentioned that wget is not available in Windows by default, and I realized that only diffpy.cmi needs to be installed from conda, I'm thinking about changing it into:
But then you need to install its dependency `diffpy.cmi` manually. Run the command::
conda install diffpy.cmi
What do you think about it?
ycexiao
left a comment
ycexiao
left a comment
There was a problem hiding this comment.
@sbillinge, it's ready for review.
README.rst
Outdated
|
|
||
| pip install pdfbl.sequential | ||
|
|
||
| But then you need to install its dependency `diffpy.cmi` manually. Run the command:: |
There was a problem hiding this comment.
The installation instructions have been updated per the comment.
README.rst
Outdated
|
|
||
| pip install pdfbl.sequential | ||
|
|
||
| But then you need to install its dependency `diffpy.cmi` manually. Run the command:: |
There was a problem hiding this comment.
isn't it better to install this before pip installing pdfbl.sequential so there aren't lots of scary messages about dependencies not building properly?
ycexiao
left a comment
ycexiao
left a comment
There was a problem hiding this comment.
@sbillinge, it's ready for review.
| If the above does not work, you can use ``pip`` to download and install the latest release from | ||
| `Python Package Index <https://pypi.python.org>`_. | ||
| To install using ``pip`` into your ``pdfbl.sequential_env`` environment, type :: | ||
| You can also use ``pip`` to download and install the latest release from |
There was a problem hiding this comment.
Install diffpy.cmi dependency first.
2 participants
What problem does this PR address?
Closes #41
What should the reviewer(s) do?
Please check the installation instructions.